YNQ  YNQ-1.5.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Open Files Enumeration

Data Structures

struct  FileDataA_t
 
struct  CSFileData
 

Functions

NQ_BOOL csEnumerateOpenFilesA (NQ_UINT index, FileDataA_t *fileData)
 
NQ_BOOL csEnumerateOpenFiles (NQ_UINT index, CSFileData *fileData)
 

Detailed Description

Function Documentation

NQ_BOOL csEnumerateOpenFilesA ( NQ_UINT  index,
FileDataA_t fileData 
)

This function is used to retrieve all open files and directories on NQ Server. Call this function inside a loop and continue till False result is returned. On first call index should be 0, advance index by one per call to this function.

File data will be filled in function parameter fileData, unless returned value is false.

If a file is opened or closed during the loop calling this function, the returned values might not exactly reflect the open files situation.

Parameters
indexIndex is indicating which open file data to return. Upon 2nd call the 2nd open file in the internal DB will be returned. On call x, the x'th open file will be returned. For NQ Storage zero index is signaling function to start iteration. Next calls must have any index > 0.
fileDataPointer to a structure, where NQ places the file data for this index. See FileDataA_t structure.
Returns
This function returns TRUE if the requested file index exists. False - if the requested file index doesn't exist.
Note
  • Be sure to start any loop call to this function with index 0.
  • This function is non reentrant
  • This is an ASCII version of csEnumerateOpenFiles()
NQ_BOOL csEnumerateOpenFiles ( NQ_UINT  index,
CSFileData fileData 
)

This function is used to retrieve all open files and directories on NQ Server. Call this function inside a loop and continue till False result is returned. On first call index should be 0, advance index by one per call to this function.

File data will be filled in function parameter fileData, unless returned value is false.

If a file is opened or closed during the loop calling this function, the returned values might not exactly reflect the open files situation.

Parameters
indexIndex is indicating which open file data to return. Upon 2nd call the 2nd open file in the internal DB will be returned. On call x, the x'th open file will be returned. For NQ Storage zero index is signaling function to start iteration. Next calls must have any index > 0.
fileDataPointer to a structure, where NQ places the file data for this index. See CSFileData structure.
Returns
This function returns TRUE if the requested file index exists. False - if the requested file index doesn't exist.
See Also
CSFileData structure.
Note
  • Be sure to start any loop call to this function with index 0.
  • This function is non reentrant